Skip to content

Commit

Permalink
[nop] Update project template
Browse files Browse the repository at this point in the history
  • Loading branch information
@ptaoussanis
ptaoussanis committed Sep 26, 2023
1 parent 50a93c8 commit a51a54a
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
38 changes: 19 additions & 19 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This is a safe update for users of `1.19.0`.
This is intended as a **non-breaking maintenance release**, but it touches a lot of code so **please keep an eye out** for (and let me know about) any unexpected problems - thank you! 🙏

**Tip**: the [reference example](https://github.com/ptaoussanis/sente/tree/master/example-project) includes a number of tools to help test Sente in your environment.
**Tip**: the [reference example](https://github.com/taoensso/sente/tree/master/example-project) includes a number of tools to help test Sente in your environment.

### Fixes since `1.18.1`

Expand Down Expand Up @@ -107,14 +107,14 @@ See [here](https://github.com/taoensso/sente/wiki/0-Breaking-changes#sente-v117-
* 45e1880 [new] [#422] Add client-side util to simulate a broken connection
* 627029f [new] [Experimental] Add support for 3-arity (async) Ring v1.6+ handlers
* 221f112 [new] [Example] Update, improve reference example
* Introduced a new [community docs wiki](https://github.com/ptaoussanis/sente/wiki)
* Introduced a new [community docs wiki](https://github.com/taoensso/sente/wiki)

### Other improvements since `1.17.0`

* 057a8cb [new] Add interface docstrings
* c6aca8c [nop] [#406] Clarify client+server docstrings re: csrf-token
* 8b9804e [nop] Mark deprecated vars
* Major improvements to [example project](https://github.com/ptaoussanis/sente/tree/master/example-project)
* Major improvements to [example project](https://github.com/taoensso/sente/tree/master/example-project)
* Many other small improvements to implementation, documentation, etc.


Expand All @@ -125,7 +125,7 @@ See [here](https://github.com/taoensso/sente/wiki/0-Breaking-changes#sente-v117-
```

> This is a non-breaking **maintenance and feature release**.
> See [here](https://github.com/ptaoussanis/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
> See [here](https://github.com/taoensso/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
Identical to `v1.17.0-RC2`.

Expand Down Expand Up @@ -153,7 +153,7 @@ Identical to `v1.17.0-RC2`.
```

> This is a non-breaking **maintenance and feature release**.
> See [here](https://github.com/ptaoussanis/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
> See [here](https://github.com/taoensso/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
### Changes since `1.16.2`

Expand All @@ -179,7 +179,7 @@ Identical to `v1.17.0-RC2`.
```

> This is a non-breaking **minor maintenance release**.
> See [here](https://github.com/ptaoussanis/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
> See [here](https://github.com/taoensso/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
### New since `1.16.1`

Expand All @@ -197,7 +197,7 @@ Identical to `v1.17.0-RC2`.
```

> This is a **minor maintenance release**.
> See [here](https://github.com/ptaoussanis/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
> See [here](https://github.com/taoensso/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
### Fixes since `1.16.0`

Expand All @@ -214,7 +214,7 @@ Identical to `v1.17.0-RC2`.
[com.taoensso/sente "1.16.0"]
```

> Major feature release. Should be non-breaking, but see [here](https://github.com/ptaoussanis/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
> Major feature release. Should be non-breaking, but see [here](https://github.com/taoensso/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
Same as `v1.16.0-RC1`, `v1.16.0-alpha2`.

Expand Down Expand Up @@ -248,7 +248,7 @@ Same as `v1.16.0-RC1`, `v1.16.0-alpha2`.

Same as `v1.16.0-alpha2`.

> See [here](https://github.com/ptaoussanis/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.
> See [here](https://github.com/taoensso/encore#recommended-steps-after-any-significant-dependency-update) for recommended steps when updating any Clojure/Script dependencies.

## v1.16.0-alpha2 - 2020 Aug 24
Expand All @@ -265,7 +265,7 @@ Same as `v1.16.0-alpha2`.
2. Run `lein clean` (or equivalent) to ensure no stale build artifacts remain.
3. Please test carefully before running in production!

Some info on how to resolve dependency conflicts [here](https://github.com/ptaoussanis/encore/blob/master/DEP-CONFLICT.md).
Some info on how to resolve dependency conflicts [here](https://github.com/taoensso/encore/blob/master/DEP-CONFLICT.md).

#### Changes since `v1.15.0`

Expand Down Expand Up @@ -335,20 +335,20 @@ As `v1.14.0-RC2`, but also includes:

### Security fix details

- The fix [commit](https://github.com/ptaoussanis/sente/commit/ae3afd5cf92591c9f756c3177142bee7cccb8b6b) stops the CSRF token leak, introducing a **BREAKING API CHANGE** (details below).
- The fix [commit](https://github.com/taoensso/sente/commit/ae3afd5cf92591c9f756c3177142bee7cccb8b6b) stops the CSRF token leak, introducing a **BREAKING API CHANGE** (details below).
- Sente will now (by default) refuse to service any requests unless a CSRF token is detected (e.g. via `ring-anti-forgery`).

### Breaking changes

#### `make-channel-socket-client!` now takes an extra mandatory argment

It now takes an explicit `csrf-token` that you must provide. The value for the token can be manually extracted from the page HTML ([example](https://github.com/ptaoussanis/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/client.cljs#L33)).
It now takes an explicit `csrf-token` that you must provide. The value for the token can be manually extracted from the page HTML ([example](https://github.com/taoensso/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/client.cljs#L33)).

In most cases the change will involve three steps:

1. You need to include the server's CSRF token somewhere in your page HTML: [example](https://github.com/ptaoussanis/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/server.clj#L69).
2. You need to extract the CSRF token from your page HTML: [example](https://github.com/ptaoussanis/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/client.cljs#L33).
3. You'll then use the extracted CSRF token as an argument when calling `make-channel-socket-client!`: [example](https://github.com/ptaoussanis/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/client.cljs#L52).
1. You need to include the server's CSRF token somewhere in your page HTML: [example](https://github.com/taoensso/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/server.clj#L69).
2. You need to extract the CSRF token from your page HTML: [example](https://github.com/taoensso/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/client.cljs#L33).
3. You'll then use the extracted CSRF token as an argument when calling `make-channel-socket-client!`: [example](https://github.com/taoensso/sente/blob/548af55c5eb13a53e451b5214f58ecd45f20b0a5/example-project/src/example/client.cljs#L52).

#### Client-side `:chsk/handshake` event has changed

Expand Down Expand Up @@ -528,7 +528,7 @@ Most users won't be affected by this change.

#### Notes

**[1]** Please see https://github.com/ptaoussanis/timbre/releases/tag/v4.0.0 for Timbre v4's **migration checklist**. Sorry for the hassle! This one-off change allows Sente to inherit all of Timbre's logging goodness (full logging config, ns filtering, production logging call elision, etc.). Migration usu. consists of a 1 or 2 line change if you're not using custom Timbre appenders.
**[1]** Please see https://github.com/taoensso/timbre/releases/tag/v4.0.0 for Timbre v4's **migration checklist**. Sorry for the hassle! This one-off change allows Sente to inherit all of Timbre's logging goodness (full logging config, ns filtering, production logging call elision, etc.). Migration usu. consists of a 1 or 2 line change if you're not using custom Timbre appenders.

## v1.5.0 - 2015 Jun 11

Expand Down Expand Up @@ -599,9 +599,9 @@ So:
<opts-map) ; NEW Clojure-side chsk constructor
```

This change is a once-off nuisance that'll allow us the freedom of supporting a wide range of web servers in the future. Interested in a web server besides http-kit or Immutant? Am now [welcoming PRs](https://github.com/ptaoussanis/sente/issues/102) to support additional web servers.
This change is a once-off nuisance that'll allow us the freedom of supporting a wide range of web servers in the future. Interested in a web server besides http-kit or Immutant? Am now [welcoming PRs](https://github.com/taoensso/sente/issues/102) to support additional web servers.

Finally, **please see the updated [reference example project](https://github.com/ptaoussanis/sente/tree/master/example-project) for instructions on switching to an alternative web server like Immutant.**
Finally, **please see the updated [reference example project](https://github.com/taoensso/sente/tree/master/example-project) for instructions on switching to an alternative web server like Immutant.**

/ Peter Taoussanis

Expand Down Expand Up @@ -630,7 +630,7 @@ Finally, **please see the updated [reference example project](https://github.com

## v1.1.0 / 2014 Sep 7

* **FIX**: https://github.com/ptaoussanis/timbre/issues/79 (unnecessary deps being pulled in).
* **FIX**: https://github.com/taoensso/timbre/issues/79 (unnecessary deps being pulled in).
* **NEW**: Added client-side `ajax-call` utility.
* **NEW**: Added keys to `event-msg`s: `:id` (event-id), `:?data` (event-?data).

Expand Down
4 changes: 2 additions & 2 deletions example-project/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This example dives into Sente's full functionality pretty quickly; it's probably more useful as a reference than a tutorial.

Please see Sente's [top-level README](https://github.com/ptaoussanis/sente) for a gentler introduction to Sente.
Please see Sente's [top-level README](https://github.com/taoensso/sente) for a gentler introduction to Sente.

## Instructions

Expand All @@ -22,6 +22,6 @@ Please see Sente's [top-level README](https://github.com/ptaoussanis/sente) for
3. Follow the instructions from that page.

3. Connect your dev environment to that nREPL server, e.g. `(cider-connect)` from Emacs.
4. Open the example's [`server.clj`](https://github.com/ptaoussanis/sente/blob/master/example-project/src/example/server.clj) file in your dev environment.
4. Open the example's [`server.clj`](https://github.com/taoensso/sente/blob/master/example-project/src/example/server.clj) file in your dev environment.
5. Eval `(example.server/start!)` to start a local HTTP server and auto-open a test page in your web browser.
6. Follow the instructions from that page.
2 changes: 1 addition & 1 deletion wiki/0-Breaking-changes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ More info at: [#319](../issues/319)

The default [`*write-legacy-pack-format?*`](http://taoensso.github.io/sente/taoensso.sente.html#var-*write-legacy-pack-format.3F*) value has changed from `true` to `false`.

This change is only relevant for the small minority of folks that use a custom (non-standard) [`IPacker`](https://github.com/ptaoussanis/sente/blob/f69a5df6d1f3e88d66a148c74e1b5a9084c9c0b9/src/taoensso/sente/interfaces.cljc#L55).
This change is only relevant for the small minority of folks that use a custom (non-standard) [`IPacker`](https://github.com/taoensso/sente/blob/f69a5df6d1f3e88d66a148c74e1b5a9084c9c0b9/src/taoensso/sente/interfaces.cljc#L55).

If you do use a custom (non-standard) `IPacker`, please see the [relevant docstring](http://taoensso.github.io/sente/taoensso.sente.html#var-*write-legacy-pack-format.3F*) for details.

Expand Down
2 changes: 1 addition & 1 deletion wiki/1-Getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ deps.edn: com.taoensso/sente {:mvn/version "x-y-z"}

## Server-side setup

First make sure that you're using one of the [supported web servers](https://github.com/ptaoussanis/sente/tree/master/src/taoensso/sente/server_adapters) (PRs for additional server adapters welcome!).
First make sure that you're using one of the [supported web servers](https://github.com/taoensso/sente/tree/master/src/taoensso/sente/server_adapters) (PRs for additional server adapters welcome!).

Somewhere in your web app's code you'll already have a routing mechanism in place for handling Ring requests by request URL. If you're using [Compojure](https://github.com/weavejester/compojure) for example, you'll have something that looks like this:

Expand Down

0 comments on commit a51a54a

Please sign in to comment.