Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update remapping order of __ns and __node to not affect each other #299

Closed
wants to merge 5 commits into from
Closed

Update remapping order of __ns and __node to not affect each other #299

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
873ada9
Update with nodename prefix to support FQN and remapping order
Sep 22, 2020
93a1b51
update namespace and node name remapping to not affect each other
Oct 19, 2020
520d649
make the example description more clear
Oct 20, 2020
31ca246
update with better wording
Oct 21, 2020
33770a1
Add an example for mixed rules
Oct 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions articles/141_static_remapping.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,7 @@ The replacement must be a single token which will become the node's new name.

Remapping rules are applied in the following order:

1. Node name remapping
1. Namespace remapping
1. Namespace or Node name remapping
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so now name are namespace rules are applied in the order they appear, right?

It would be great to make that clear here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

order they appear

This is not the case, they order doesn't matter.
Their prefix is always the node name before remapping, maybe that can be made more clear.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the case, they order doesn't matter.

They're still ordered within a rule, right? If I give talker:__node:=foo and talker:__node:=bar, then is the final name is foo?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ivanpauno

name and namespace rules are applied in the order they appear, right?

they order doesn't matter

the order of name and namespace rules doesn't matter.
I think users like to understand some rules by referring to an example description.

  • A user gives the rules talker:__ns:=/my_namespace then talker:__node:=foo, or vice versa

@sloretz

They're still ordered within a rule, right?

I supposed you mean the order of multiple items about __node or __ns, the answer is yes.

If I give talker:__node:=foo and talker:__node:=bar, then is the final name is foo?

Yes.
Actually, the example description already showed messages,

  • talker's namespace is /foo because that rule was given first
    though the above example uses talker:__ns:=/foo and __ns:=/bar

About this kind of information, I'll not update it in this PR.

1. All other rules

Within each category, the rules are applied in the order in which the user gave them.
Expand All @@ -339,15 +338,21 @@ Within each category, the rules are applied in the order in which the user gave
**Example of node/namespace remapping order:**

- A node has name `talker`
- A user gives the rules `talker:__ns:=/my_namespace` then `talker:__node:=foo`
- The final namespace is the default `/` because the node name remap is applied before the namespace remap
- A user gives the rules `talker:__ns:=/my_namespace` then `talker:__node:=foo`, or vice versa
- The final fully qualified name is `/my_namespace/foo` because the namespace and node name remap rules both match against the original node name before remappings are applied

**Example of a default and node specific namespace remap:**

- A node has name `talker`
- A user gives the rules `talker:__ns:=/foo` then `__ns:=/bar`
- talker's namespace is `/foo` because that rule was given first

**Example of node and topic/service remapping order:**

- A node uses a name `/talker` and a topic/service name `/bar`
- A user gives the rules `talker:__node:=foo` then `foo:bar:=/asdf`
- The final fully qualified name is `/foo`, and the final topic/service name is `/asdf` because the node name remap rule is matched before other remappings are applied

### Applications of the syntax

The following sections explain how the syntax enables the use cases above.
Expand Down