Introduce new response headers for world readable/writable realm #999
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FadhlanR
requested review from
lukemelia,
backspace,
jurgenwerk and
burieberry
Test Results491 tests ±0 487 ✔️ ±0 6m 37s ⏱️ +9s Results for commit 03c528f. ± Comparison against base commit d75de62. This pull request removes 491 and adds 491 tests. Note that renamed tests count towards both.This pull request removes 4 skipped tests and adds 4 skipped tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
backspace
approved these changes
Jan 26, 2024
| assert.true( | ||
| response.get('X-realm-public-writable') != undefined, | ||
| 'realm is public writable', | ||
| ); |
There was a problem hiding this comment.
Would these and below work with assert.ok(response.get('X-realm-public-writable')) instead? It seems a bit more concise to just check for truthiness.
| @@ -9,6 +12,8 @@ export function createResponse( | |||
| headers: { | |||
| ...init?.headers, | |||
| 'X-Boxel-Realm-Url': unresolvedRealmURL, | |||
| ...(permissions['*'].includes('read') && { 'X-Realm-Public-Readable': 'true' }), | |||
| ...(permissions['*'].includes('write') && { 'X-Realm-Public-Writable': 'true' }), | |||
There was a problem hiding this comment.
Since we already have X-Boxel-Realm-… maybe these should follow that pattern? X-Boxel-Realm-Public-Readable
backspace
reviewed
Jan 26, 2024
jurgenwerk
reviewed
Jan 28, 2024
There was a problem hiding this comment.
I think passing realm permissions config along so far into response creating functions and having related logic there might not be ideal. I'm leaning towards thinking the logic for telling whether the realm is publicly readable or writable should be the responsibility of the realm itself - I'd consider adding realm.isPubliclyReadable and realm.isPubliclyWritable getters and using that for determining response headers. It would also be a bit easier to refactor once we move to Postgres
Co-authored-by: Buck Doyle <[email protected]>
jurgenwerk
reviewed
Jan 29, 2024
packages/runtime-common/realm.ts
Outdated
| @@ -705,30 +715,30 @@ export class Realm { | |||
| '7d', | |||
| this.#realmSecretSeed, | |||
| ); | |||
| return createResponse(this.url, null, { | |||
| return createResponse(this.url, this.isPublicReadable, this.isPublicWritable, null, { | |||
There was a problem hiding this comment.
Given that all first three params are properties of realm maybe at this point we can just pass realm and read the needed properties in createResponse?
jurgenwerk
approved these changes
Jan 30, 2024
…-readable-writable
delete-merged-branch
bot
deleted the
cs-6535-introduce-response-headers-for-world-readable-writable
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, I added new headers
X-Realm-Public-ReadableandX-Realm-Public-Writablefor world readable/writable realm.*) I'm not sure with world writable realm. Do we need that?