Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@joeshaw
Copy link
Member

@joeshaw joeshaw commented Feb 3, 2023

object_store becomes object_stores
secret_store becomes secret_stores
path becomes file

This makes these more consistent with other parts of the manifest like
dictionaries, backends, geolocation, etc.

Companion to fastly/Viceroy#206

`object_store` becomes `object_stores`
`secret_store` becomes `secret_stores`
`path` becomes `file`

This makes these more consistent with other parts of the manifest like
dictionaries, backends, geolocation, etc.

Companion to fastly/Viceroy#206
@joeshaw joeshaw force-pushed the joeshaw/local-server-format-updates branch from fef43aa to fff82d3 Compare February 3, 2023 20:57
@joeshaw
Copy link
Member Author

joeshaw commented Feb 3, 2023

Lint CI error is caused by an old Go version. I filed #790 for that.

I think this PR is probably not enough currently as-is. We might need to migrate the old object_store key to the new object_stores key to ensure they're not discarded when the file is re-serialized. I'm not sure the best way to do that.

@Integralist
Copy link
Collaborator

👋🏻

This might be a breaking interface change for the fastly.toml manifest which would require the manifest_version field to be bumped from 2 to 3. But after reviewing its documentation page https://developer.fastly.com/reference/compute/fastly-toml/ I don't see either object_store or secret_store documented.

So I'm not sure how we proceed because normally this would be considered a 'new addition' (rather than a breaking interface change, because nothing has been documented) but I had a feeling there were people already using these local_server fields (maybe as part of beta access) so by changing them here we're going to break projects/expectations (even if it's currently undocumented).

Also, I know that @chrispoole643 has an internal PR open to document object_store so you might need to co-ordinate with him regarding the pluralisation object_stores as well as documentation for secret_stores.

@triblondon
Copy link
Contributor

I'm doing the docs right now and I'd like to call it object_stores. Because these products are all beta and not previously documented, breaking change should be fine.

@Integralist
Copy link
Collaborator

UPDATE:
I spoke with @triblondon who is working on documenting these features and he is going to be using the plurals, and that as users would have been testing these features under a 'beta' PLC it's fine for us to change the interface (and as it's not documented officially, yet, we can treat this as the final implementation and so leave the manifest_version at version 2).

So in summary: This PR is fine to go ahead. I've also approved its dependant PR.

@Integralist Integralist added the enhancement New feature or request label Feb 6, 2023
@joeshaw joeshaw merged commit 4e9028d into main Feb 6, 2023
@joeshaw joeshaw deleted the joeshaw/local-server-format-updates branch February 6, 2023 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants